The API Keys section enables API Keys to be generated for the organisation to use the external events API.
| Option | Description / Usage |
|---|---|
| API Keys | |
| API Key Name | Entry box to define a user friendly name for the identification of the key |
| Password | Enter box to define the password for the key, a minimum of 10 characters is required |
| Outlets | Drop down to define the part of the organisation the key will apply too |
Configuring New API Keys
-
From Estate Admin menu select API Keys | click Add New API Key
-
Enter a Name for the API Key for identification
-
Enter a Password | passwords must be at least 10 characters
-
Select either Estate | or Company | or Outlet to which you want to apply the key
-
Click Save Changes
Changing API Key Passwords
It is only possible to update passwords, key names or IDs are not able to be amended.
-
From Estate Admin menu select API Keys | select an existing key by clicking Edit
-
Update the password, click Save Changes
Deleting API Keys
-
From Estate Admin menu select API Keys | select an existing key by clicking Delete
-
Confirm OK you wish to delete the key
Zonal recommend you always check carefully that the key you are about to delete is not in use, it is recommended to disable the key in the first instance
Once a key has been delete it is not possible to be reinstated